doc: Add OstreeMutableTree, other minor doc updates

diff --git a/doc/ostree-docs.xml b/doc/ostree-docs.xml
index ba6e7cdd19f04b3ba30c3d5f67d6a68773eefbc3..0b50ea3c8a98697f65fd8fb7985de13aade6cc92 100644 (file)
--- a/doc/ostree-docs.xml
+++ b/doc/ostree-docs.xml
@@ -21,6 +21,7 @@
                <title>API Reference</title>
                <xi:include href="xml/libostree-core.xml"/>
                <xi:include href="xml/libostree-repo.xml"/>
+               <xi:include href="xml/libostree-mutable-tree.xml"/>
 
                <index id="api-index-full">
                        <title>API Index</title>

diff --git a/doc/ostree-sections.txt b/doc/ostree-sections.txt
index 45d11346b6b47aa50367c3af187f634fc96651f9..e4233dbfc4570869386ac50908f82b3689df8f9d 100644 (file)
--- a/doc/ostree-sections.txt
+++ b/doc/ostree-sections.txt
@@ -51,6 +51,7 @@ ostree_commit_get_parent
 
 <SECTION>
 <FILE>libostree-repo</FILE>
+OstreeRepo
 OstreeRepoMode
 ostree_repo_new
 ostree_repo_new_default
@@ -90,6 +91,7 @@ ostree_repo_delete_object
 OstreeRepoCommitFilterResult
 OstreeRepoCommitFilter
 OstreeRepoCommitModifier
+OstreeRepoCommitModifierFlags
 ostree_repo_commit_modifier_new
 ostree_repo_commit_modifier_ref
 ostree_repo_commit_modifier_unref
@@ -113,3 +115,20 @@ ostree_repo_prune
 OstreeRepoPullFlags
 ostree_repo_pull
 </SECTION>
+
+<SECTION>
+<FILE>libostree-mutable-tree</FILE>
+OstreeMutableTree
+ostree_mutable_tree_new
+ostree_mutable_tree_set_metadata_checksum
+ostree_mutable_tree_get_metadata_checksum
+ostree_mutable_tree_set_contents_checksum
+ostree_mutable_tree_get_contents_checksum
+ostree_mutable_tree_replace_file
+ostree_mutable_tree_ensure_dir
+ostree_mutable_tree_lookup
+ostree_mutable_tree_ensure_parent_dirs
+ostree_mutable_tree_walk
+ostree_mutable_tree_get_subdirs
+ostree_mutable_tree_get_files
+</SECTION>

diff --git a/src/libostree/ostree-mutable-tree.c b/src/libostree/ostree-mutable-tree.c
index 7ff53dc418a6b3486f2c5b3eceabaa5ff66dca58..26a1ca442132effe06bf8af6c7ed3df0ac9571e9 100644 (file)
--- a/src/libostree/ostree-mutable-tree.c
+++ b/src/libostree/ostree-mutable-tree.c
@@ -27,6 +27,23 @@
 #include "ostree-core.h"
 #include "libgsystem.h"
 
+/**
+ * SECTION:libostree-mutable-tree
+ * @title: In-memory modifiable filesystem tree
+ * @short_description: Modifiable filesystem tree
+ *
+ * In order to commit content into an #OstreeRepo, it must first be
+ * imported into an #OstreeMutableTree.  There are several high level
+ * APIs to create an initiable #OstreeMutableTree from a physical
+ * filesystem directory, but they may also be computed
+ * programmatically.
+ */
+
+/**
+ * OstreeMutableTree:
+ *
+ * Private instance structure.
+ */
 struct OstreeMutableTree
 {
   GObject parent_instance;

diff --git a/src/libostree/ostree-repo-private.h b/src/libostree/ostree-repo-private.h
index f388bfa6f0891eddf5024c9beb5209ba02a4cec7..ddd2c7a5cd503d1ec1318586d32c86b42410a0cb 100644 (file)
--- a/src/libostree/ostree-repo-private.h
+++ b/src/libostree/ostree-repo-private.h
@@ -24,6 +24,11 @@
 
 G_BEGIN_DECLS
 
+/**
+ * OstreeRepo:
+ *
+ * Private instance structure.
+ */
 struct OstreeRepo {
   GObject parent;